home *** CD-ROM | disk | FTP | other *** search
/ Atari Mega Archive 1 / Atari Mega Archive - Volume 1.iso / utils / cleo.arc / CLEO.DOC next >
Text File  |  1989-09-19  |  6KB  |  102 lines
  1.  
  2.  
  3.     CLEO (Command Line Editing Otherwise) is a TSR (Terminate and Stay
  4.     Resident) program to be placed in the boot device's AUTO folder.
  5.     It replaces the GEMDOS function Cconrs (READSTRING) by a more advanced
  6.     editing capability (if in/output is not being redirected). It
  7.     includes a history mechanism, filename completion, cursor movement.
  8.     All programs that use Cconrs in some way or another can make good use
  9.     of it (notably some shells). Often standard library functions like
  10.     gets() are implemented through Cconrs (e.g. Lattice C).
  11.  
  12.     Some remarks:
  13.     a) CLEO tries to keep track of the prompt string, that is: whenever
  14.     the current input buffer needs to be redisplayed on a new line, the
  15.     prompt before the input buffer is being redisplayed too (if possible).
  16.     b) CLEO uses a warning bell to indicate a possible error (cannot move,
  17.     cannot delete, no files found/matched, cannot recall). This bell can be
  18.     disabled.
  19.     c) The current buffer can extend over several physical lines. A
  20.     restriction implied by GEMDOS is that it can contain at most 255
  21.     characters.
  22.     d) Currently CLEO grabs about 14 K of your free memory. This includes
  23.     space for 20 255-byte buffers.
  24.  
  25.     A detailed description of the function keys in CLEO will be given now:
  26.     HELP            Displays the function keys of CLEO in a compressed way.
  27.                     The current buffer is redisplayed after the help text.
  28.     CURSOR LEFT     Move the cursor to the left throught the current buffer.
  29.                     Ring the warning bell if at the start of the buffer.
  30.     CURSOR RIGHT    Move the cursor to the right throught the current buffer.
  31.                     Ring the warning bell if at the end of the buffer.
  32.     CURSOR UP       Move up in the history. Each time an older buffer is being
  33.                     displayed (there can be up to 20 history buffers). After
  34.                     the last one the current buffer is cleared again.
  35.     CURSOR DOWN     Move down in the history. Each time a more recent buffer
  36.                     is being displayed.
  37.     CLRHOME         Either recalls a history buffer into the current buffer,
  38.                     or shows all the history buffers. If the current buffer
  39.                     is empty, all history buffers are shown, in reverse order
  40.                     (the most recent one last, numbered 1). If it starts with
  41.                     a number, it is taken to be the history buffer's number.
  42.                     If it is a string, the history buffers are searched for a
  43.                     (prefix) match (starting with the most current one). In
  44.                     the latter two cases, if a matching history buffer is
  45.                     found the current buffer is filled with that buffer;
  46.                     otherwise the warning bell is rung.
  47.     UNDO            Toggles literalness/interpretation of control characters
  48.                     (including Escape, Return and Backspace). In literal mode
  49.                     a control character's function is not performed, but the
  50.                     character is entered literally into the buffer. This mode
  51.                     is always reset to interpreted for the next call.
  52.     INSERT          Toggle insert/replace mode for characters. Standard is
  53.                     insert mode: characters to the right of the cursor are
  54.                     being shifted to the right when new characters are being
  55.                     entered. In replace mode newly typed characters replace
  56.                     the ones already there (characters are not being shifted).
  57.                     This mode is preserved (remembered) for the next call.
  58.     DELETE          Delete the character at the cursor. Ring the warning bell
  59.                     if at the end of the current buffer.
  60.     CONTROL A       Move cursor to the beginning of the current buffer. Ring
  61.                     the warning bell if already there.
  62.     CONTROL B       Move cursor to the beginning of the word preceding the
  63.                     cursor. Ring the warning bell if at the start of the
  64.                     current buffer.
  65.     CONTROL C       Stop the current program (exitcode -32).
  66.     CONTROL D       List the files whose names match the word before the
  67.                     cursor, sorted by name. If this word contains a
  68.                     directory specification, a file's name must match this
  69.                     directory completely (the file must reside in that
  70.                     directory). In this case the directory specification
  71.                     of the word must end in a \. Ring the warning bell if
  72.                     no files matched.
  73.     ESCAPE          Like Control D, only now don't show the files, but
  74.                     insert(/replace) at the cursor the common part of the
  75.                     matching files' names (e.g. complete the file name as
  76.                     far as it is uniquely identifiable). Ring the warning
  77.                     bell if there was not a single match.
  78.     CONTROL E       Move cursor to the end of the current buffer. Ring the
  79.                     warning bell if already there.
  80.     CONTROL F       Move cursor to the beginning of the next word. Ring the
  81.                     warning bell if already at the end of the current buffer.
  82.     CONTROL G       Toggle to disable/enable the warning bell. This toggle's
  83.                     value is preserved (remembered) for the next call.
  84.     CONTROL H
  85.     BACKSPACE       Delete the character before the cursor. Ring the warning
  86.                     bell if already at the start of the current buffer.
  87.     CONTROL J
  88.     CONTROL M       End of input. For compatibility with GEMDOS a carriage
  89.                     return is printed, and the character is not entered into
  90.                     the current buffer (the cursor is first moved to the end
  91.                     of the current buffer if not already there). The input
  92.                     is also ended when the max. count is reached (whose value
  93.                     was passed by the user as the value of the first char in
  94.                     the buffer.
  95.     CONTROL L
  96.     CONTROL R       Redisplay the current buffer.
  97.     CONTROL U       Clear the current buffer.
  98.     CONTROL W       Delete the word preceding the cursor.
  99.     CONTROL X       Delete through the start of the current buffer.
  100.  
  101.  
  102.